home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 2 / Apprentice-Release2.iso / Source Code / C / Libraries / stdwin / Doc / man / x11stdwin.man < prev   
Encoding:
Text File  |  1988-06-29  |  8.1 KB  |  258 lines  |  [TEXT/????]
  1. .TH X11-STDWIN 1
  2. .SH NAME
  3. X11-STDWIN \- a Standard Window System Interface, X11 version
  4. .SH SYNOPSIS
  5. .I application
  6. [
  7. .B \-display
  8. .I display-name
  9. ]
  10. [
  11. .B \-name
  12. .I program-name
  13. ]
  14. [
  15. .B \-geometry
  16. .I geometry-spec
  17. ]
  18.  [
  19. .B \-font
  20. .I font-name
  21. ]
  22. [
  23. .B \-menufont
  24. .I font-name
  25. ]
  26. [
  27. .B \-iconic
  28. ]
  29. [
  30. .B \-icongeometry
  31. .I geometry-spec
  32. ]
  33.  [
  34. .B \-foreground
  35. .I color-spec
  36. ]
  37. [
  38. .B \-background
  39. .I color-spec
  40. ]
  41.  [
  42. .B \-menuforeground
  43. .I color-spec
  44. ]
  45. [
  46. .B \-menubackground
  47. .I color-spec
  48. ]
  49.  [
  50. .B \-reverse
  51. ]
  52. [
  53. .B \-xrm
  54. .I string
  55. ]
  56. [
  57. .B \-debuglevel
  58. .I number
  59. ]
  60. [
  61. .B \-synchronous
  62. ]
  63. [
  64. .I option
  65. ] ...
  66. .SH DESCRIPTION
  67. .I STDWIN
  68. is a standard interface available for several window systems.
  69. This man page describes the common aspects of applications written using
  70. STDWIN when run under MIT's X Window System, Version 11.
  71. .SH COMMAND LINE OPTIONS
  72. Most applications (to be precise, those that use the
  73. .I winitnew
  74. call to initialize STDWIN) will accept all options shown in the
  75. synopsis.
  76. For most options there can also be a corresponding
  77. .I resource
  78. (option string stored in the X server or in ~/.Xdefaults).
  79. Command line options override resources; resources override defaults
  80. built in the application; application defaults override library defaults.
  81. Unless otherwise stated, the resources have the same name as the command
  82. line options (all in lower case), prefixed with ``.stdwin''.
  83. For example, the full name of the resource corresponding to the
  84. ``\-font'' option is named
  85. .IR program .stdwin.font.
  86. Since most options have a standard meaning for most X applications, they
  87. are not explained in great length here.
  88. Options with a specific meaning for STDWIN are:
  89. .TP
  90. .BI \-font " font-name"
  91. Specifies the font to be used by default in text drawn by the
  92. application.
  93. Both proportional and fixed-width fonts are acceptable
  94. (except that some old applications look nicer with a fixed-width font).
  95. The library default is to use the X server's default (usually 8x13).
  96. .TP
  97. .BI \-menufont " font-name"
  98. Specifies the font to be used in menus and dialog boxes.
  99. The library default is to use the same font as for normal text.
  100. .TP
  101. .BI \-foreground " color-spec, " \-background " color-spec"
  102. Specify the colors to be used in the application's part of the window.
  103. The defaults are black and white.
  104. .TP
  105. .BI \-menuforeground " color-spec, " \-menubackground " color-spec"
  106. Specify the colors to be used in the menu bar, the scroll bars,
  107. dialog boxes and for the window border (the foreground color).
  108. By default the same values are used as for
  109. .B \-foreground
  110. and
  111. .BR \-background .
  112. .TP
  113. .B \-reverse
  114. Reverses the uses of foreground and background colors.
  115. .TP
  116. .BI \-debuglevel " number"
  117. Specifies the amount of debugging output you want; the higher the
  118. number, the more output you have to wade through.
  119. The library default is wisely 0.
  120. .TP
  121. .B \-synchronous
  122. Specifies that you want the connection with the X server to be
  123. maintained in synchronous mode (each request immediately sent and a
  124. reply waited for).
  125. This is sometimes useful while debugging.
  126. Note that synchronous mode can tremendously reduce drawing efficiency.
  127. Synchronous mode is not set automatically when the debugging level is
  128. nonzero, since some bugs go away when it is turned on!
  129. This option has no corresponding resource.
  130. .SH SCROLL BARS
  131. All STDWIN applications have two scroll bars (which may be inactive),
  132. one to the left of the window and one at the bottom.
  133. Operation and interpretation of the scroll bars is intended to be
  134. identical to the scroll bars of applications using the X toolkit
  135. (e.g., xterm).
  136. Summarizing:
  137. the left button click scrolls forward, the amount varying with
  138. the position of the click in the bar (for the vertical bar, remember
  139. ``line to top'');
  140. the right button similarly scrolls back (``top to line'');
  141. the middle button moves the beginning of the position indicator
  142. (the gray block) to the position where the button is pressed.
  143. .SH MENUS
  144. All STDWIN applications display one or more menu titles in a
  145. ``menu bar'' at the top of the window.
  146. Pressing and holding a mouse button in a menu title ``pulls down'' a
  147. menu containing text items.
  148. Sliding the mouse cursor over the text items
  149. inverts (highlights) the item over which the cursor is currently;
  150. releasing the mouse button when an item is highlighted causes the
  151. corresponding command th be executed by the application.
  152. Releasing the mouse button outside the menu selects no item.
  153. Sliding the mouse horizontally over the menu titles pulls down the other
  154. menus; at most one menu will be visible at any time.
  155. .PP
  156. One menu, labeled
  157. .BR X ,
  158. is present in all windows.
  159. Its only item, named
  160. .BR Close ,
  161. is the standard way to close the window; for single-window applications,
  162. selecting this also quits the application.
  163. The application is free to refuse closing its window, or to ask
  164. confirmation first, or to do whatever when this item is selected; it is
  165. merely a hint that you would like the window to go away, not a request.
  166. .PP
  167. Menu items may be marked (``checked'') with a `*' in the left margin; this
  168. an indicator that the function selected by the menu item is currently
  169. ``active''.
  170. The check mark can be set and cleared by the application for each menu
  171. item; the use should be apparent from the application's documentation.
  172. Menu items may be inactive (``disabled''); such items cannot be selected
  173. and will not be highlighted.
  174. Disabled items are currently indicated by a `\-' in the left margin.
  175. .PP
  176. Menu items may be selectable via a keyboard shortcut.
  177. The existence of a keyboard shortcut is shown in the menu item by the
  178. presence of the string
  179. .RI ``M- c ''
  180. in the right margin, where
  181. .I c
  182. can be any character.
  183. The M stands for ``Meta''.
  184. Holding a ``Meta'' key (possibly labeled Alt, Command, Compose, Left or
  185. some such name on your keyboard, but definitely not Control or Shift)
  186. while typing a character, usually a letter, will be
  187. equivalent to selecting the corresponding menu item with the mouse.
  188. Shortcuts are defined by the application.
  189. Some shortcuts are conventional in many applications:
  190. M-Q for Quit, M-S for Save, M-O for Open.
  191. Also M-Z for Undo, M-X for Cut, M-C for Copy and M-V for Paste
  192. (reminiscent of the Macintosh commands).
  193. Upper and lower case characters are equivalent, unless the application
  194. uses the same letter in lower and upper case as shortcuts for
  195. different menu items.
  196. .\"SH DIALOG BOXES
  197. .\"SH TEXT EDITING
  198. .\" selecting, button-2 selecting, double-click, cut/paste, delete, arrows.
  199. .SH EXAMPLE
  200. Here are some lines you could put in your resource input file:
  201.  
  202.     *stdwin*font:courier12f
  203. .br
  204.     dpv*geometry:700x850
  205. .br
  206.     klok*geometry:-1+1
  207.  
  208. This sets the font for all STDWIN applications, the initial size for
  209. .I dpv
  210. and the initial position for
  211. .I klok.
  212. Note the use of `*' for separators; extra levels of names may be
  213. inserted in the future.
  214. .SH DIAGNOSTICS
  215. .I STDWIN
  216. can issue complaints about various error conditions, e.g., font not found;
  217. these are intended to be self-explanatory.
  218. Some messages indicate STDWIN has found an inconsistency in
  219. itself or in the X server.
  220. These should be reported to the author if the cause isn't obvious.
  221. .\"SH FILES
  222. .SH SEE ALSO
  223. The X documentation (especially the chapters on command line arguments
  224. and resources).
  225. .br
  226. STDWIN \- A Standard Window System Interface, by Guido van Rossum
  227. (CWI Report number CS-R8817, April 1988).
  228. .SH AUTHOR
  229. Guido van Rossum
  230. .SH BUGS
  231. I could be sued by Apple for stealing the ``look and feel'' of some
  232. aspects of the Macintosh. :-)
  233. .br
  234. The
  235. .B \-reverse
  236. option doesn't affect the use of colors in dialog boxes.
  237. .br
  238. Like so many other window systems, X11 limits the size of windows to
  239. 64Kx64K.
  240. .br
  241. Since a STDWIN document is represented as an X11 window (scrolled inside
  242. another X11 window), applications that create really big windows (~32K
  243. pixels wide or high) may crash due to a server bug.
  244. .br
  245. When an application does no window output for some time after a menu
  246. item has been selected, the menu stays visible in its pulled-down state.
  247. .br
  248. The conventional shortcuts for Undo, Cut and Paste aren't very mnemonic.
  249. (But Apple never thought that was a problem.)
  250. .br
  251. The standard X-STDWIN command line options are best given before all
  252. application-specific options.
  253. .br
  254. If you are running an application in the background and have
  255. .I "stty tostop"
  256. turned on, warnings or errors from STDWIN may cause the program to
  257. block.
  258.